home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_1 / cdcom.zip / PROTOCOL.DOC < prev    next >
Text File  |  1992-04-18  |  12KB  |  290 lines
  1.  
  2. Supplemental doc file CdCom protocols.
  3.  
  4. Protocols for CdCom are dynamic, meaning you can add/modify/delete at will.
  5.  
  6. All protocols mentioned in this doc file will be posted on His Board
  7. (805) 652-1478 1200/2400/9600 14.4k.  They are all FREQ'able by filenames
  8. mentioned in this doc file.
  9.  
  10. PROTOCOL FILES:
  11.  
  12. PROTOCOL.BBS   -  Menu dump file for protocols (ansi = .scr)
  13. PROTOCOL.DEF   -  Main configuration file that CdCom reads
  14. PROTOCOL.BAT   -  Protocol batch file.
  15. PROTOCOL.DOC   -  This file
  16.  
  17. PROTOCOL.BBS:
  18.  
  19. This is a simple text file that is dumped to the user when they change
  20. or select a protocol.  It does not reflect what protocols are really
  21. active.  You can modify this at will to have whatever format you like.
  22. I include a sample one in the distribution file but you don't have to
  23. keep that format.  For an ansi menu make this a .SCR extension.
  24.  
  25. PROTOCOL.DEF:
  26.  
  27. This is the main configuration file for adding/modifying/removing
  28. protocols.  Format goes as follows:
  29.  
  30. The first line is the number of protocols you will be supporting.
  31.  
  32. The other lines, the protocol identification lines, must follow this
  33. format:
  34.  
  35. 1    2    3  4   5   6   7    8   9   10  11
  36. ----------------------------------------------
  37. z,Zmodem,30,115,225,450,940,1200,1400,0,s or b
  38.  
  39. 1:  Menu select command.  If the user presses z then they will get
  40.     zmodem in this example.  I reserve Q and q for <Q>uit back to Menu.
  41.     All other letters, numbers, characters are fair game. I convert it to
  42.     upper case (if its a letter) in the program.  This must only
  43.     be a single character.
  44.  
  45. 2:  Protocol name.  This is the name that will be shown to the user
  46.     when they select a protocol, also the name that will be passed to
  47.     the protocol.bat file.  Insure you match this name exactly with the
  48.     test name (%1 ==) in the batch file as it is case sensitive.  This
  49.     name is also used in the log entries.
  50.  
  51. Items 3-9 are the character/second transfer rates for the given
  52. protocol and baudrate.  This value is given to you by protocols like
  53. DSZ and superk when the transfer is complete.  Other packages may do the
  54. same.  If not you will have to time it yourself.  This gives you the option
  55. to tweak them to your hearts desire at will for each protocol and baudrate.
  56. These are the values that will be used when calculating file transfer times.
  57. I do file transfer time calculations by a division, filesize/char_sec,
  58. where char_sec is the characters per second you enter on these lines.
  59. I don't know if this is the correct way to do it, but it comes out exactly
  60. to what these protocols report so I figured it must be right.
  61.  
  62.  3:  ch/sec for 300 baud
  63.  4:  ch/sec for 1200 baud
  64.  5:  ch/sec for 2400 baud
  65.  6:  ch/sec for 4800 baud
  66.  7:  ch/sec for 9600 baud
  67.  8:  ch/sec for 19200 baud
  68.  9:  ch/sec for 38400 baud
  69.  
  70. 10: This is the DOS errorlevel that is passed for a successful
  71.     file transfer.  Most large packages like DSZ and superk pass
  72.     an errorlevel 0 for success, 1 for any error.  CdCom will check
  73.     this on return.  If a non-success error code is returned it will
  74.     ask the user if they want to re-attempt the transfer, saving the
  75.     hassle of going thru the download process again.  Note that if your
  76.     protocol is not pathed or cannot be found (bad command or filename
  77.     from dos), a 0 will be returned back into the program, and cdcom
  78.     has no way of knowing this happened, and will think the transfer went
  79.     ok.  So make sure your protocols can be found by the protocol.bat file,
  80.     either by having them pathed or in the same directory.
  81.  
  82. 11:
  83.     This specifies whether or not the protocol is a batch or single
  84.     file protocol.  To be batch the protocol has to be able to read
  85.     a filename for the files to transfer.  DSZ, Puma, and Lynx (that
  86.     I know of) do this with a @ before the filename.  Ex:
  87.     @c:\cdcom\batch.dsz
  88.     passed to DSZ will tell it to read the filename c:\cdcom\batch.dsz
  89.     for the filenames to send.  This does away with the dos command line
  90.     limitation for most protocols.  CdCom will automatically put the @,
  91.     use the path from line 2 of cdcom.def and then add the \batch.dsz
  92.     so all you need to do is check to see if the protocol supports the
  93.     @filename convention or not.  This file is overwritten each time
  94.     a transfer occurs.
  95.  
  96.     For multi-node setups a BATCH#.DSZ will be written/passed, where # is
  97.     the node number they are on so there will be no collisions.
  98.  
  99. Sample PROTOCOL.DEF file:
  100.  
  101. The ch/sec rates may or may not be correct.  I did not verify most
  102. of them so you may want to check them.
  103.  
  104. 13
  105. z,Zmodem,30,115,225,450,940,1200,1400,0,b
  106. t,MobyTurbo,30,115,225,450,940,1200,1400,0,b
  107. w,Wxmodem,30,110,210,450,940,1000,1200,0,s
  108. y,Ymodem,30,110,175,400,900,900,1000,0,s
  109. b,Ymodem-Batch,30,115,210,410,920,1000,1100,0,b
  110. x,Xmodem,30,100,175,390,880,900,950,0,s
  111. s,Sealink,30,100,175,390,880,900,950,0,s
  112. m,Megalink,30,100,175,390,880,900,950,0,s
  113. k,Kermit,30,100,175,390,880,900,950,0,s
  114. 9,K9Xmodem,30,100,175,390,880,900,950,0,s
  115. j,Jmodem,30,100,175,390,880,900,950,0,s
  116. 8,Super8K,30,100,175,390,880,900,950,0,s
  117. l,Lynx,30,100,175,390,880,900,950,0,b
  118.  
  119. IF THIS IS TOTALLY CONFUSING:
  120.  
  121. If this is your first time using file transfer protocol programs, then your
  122. best bet is to just use DSZ initially.  It supplies Xmodem (Checksum and
  123. CRC), 1k Xmodem (also called Ymodem), Ymodem-Batch, Zmodem and the Zmodem
  124. derivative MobyTurbo.  Ymodem-G is also offered for registered versions
  125. of dsz.  Call the DSZ bbs (see number is dsz section below) and get the
  126. latest version, or it may be on a local bbs.  If you find it on a bbs it
  127. will usually have the date in the filename also, like dsz0703.zip would
  128. mean dsz version date july 3.  Either source for dsz is fine, however I
  129. always get the latest dsz from the support bbs due to bad copies I've come
  130. across in the past from the local bbs's.
  131.  
  132. The protocol.bat supplied should work for 2400 baud and less systems,
  133. and for 9600 systems the ha on will have to be added to the line
  134. for zmodem, ymodem-batch and moby-turbo protocols.  This is covered
  135. in the protocol.bat file.  Then simply put the dsz program somewhere
  136. in your active dos path (like a utilities sub directory that you have
  137. pathed using the PATH command), or in the same directory as cdcom if
  138. you want, and your ready to go.  The protocols supplied by dsz should be
  139. more than enough for any system initially, and you can add others later
  140. as you get more comfortable with the programs (cdcom and protocol programs).
  141.  
  142. Your basic protocol.def would then look like so (you could mark this block
  143. and write it to a protocol.def file if you wanted):
  144.  
  145. 5
  146. z,Zmodem,30,115,225,450,940,1200,1400,0,b
  147. t,MobyTurbo,30,115,225,450,940,1200,1400,0,b
  148. y,Ymodem,30,110,175,400,900,900,1000,0,s
  149. b,Ymodem-Batch,30,115,210,410,920,1000,1100,0,b
  150. x,Xmodem,30,100,175,390,880,900,950,0,s
  151.  
  152. protocol.bbs would look like this:
  153.  
  154. [B] Ymodem-Batch, [X]modem, [Y]modem (Xmodem-1K), [Z]modem
  155. [T] MobyTurbo, [Q]uit
  156.  
  157. Like I mentioned above you shouldn't need to edit the protocol.bat file
  158. unless you are running 9600.  In that case just un-rem the 9600 line
  159. for zmodem, mobyturbo and ymodem-batch (and rem the other line without
  160. the ha on) and your set.
  161.  
  162. PROTOCOL.BAT:
  163.  
  164. In this file are some examples for various protocol packages.
  165. The examples in there should work with no problem for 2400 baud systems,
  166. and will need a little modifying for 9600 systems (handshaking for certain
  167. protocols needs to be added).  This is the same protocol.bat I use when
  168. testing the program, so one would think it would work <grin>.
  169.  
  170. It will still be up to you however to read the docs for each protocol to
  171. get it to work correctly on your system, especially if you are running
  172. locked port or anything like that.  Dsz does not need to be told information
  173. like this, in fact it is the easiest to use in that respect, but other
  174. protocols may need such information.
  175.  
  176. Cdcom passes the following parameters via DOS variables %1, %2, %3, %4,
  177. %5 and %6 to protocol.bat for use with the protocols.
  178.  
  179. %1 - Protocol name
  180.  
  181. %2 - Port number [1-4].
  182.  
  183. %3 - Baud Rate.  This is the value it reads from CALLINFO.BBS line 2.
  184.      This is not the locked port speed (or at least it should not be).
  185.  
  186. %4 - Filename to be sent.  Remember for batch downloads this will actually
  187.      be a list of filenames not individual filenames.
  188.  
  189. %5 - Port Rate.  This will be the locked rate if port is locked.  It is
  190.      read from CALLINFO.BBS line 31.
  191.  
  192. %6 - Node number.  Although this is not used by the protocols, you can use
  193.      it for testing which node you are on, in case you need it.
  194.  
  195. FILE PROTOCOL PROGRAMS:
  196.  
  197. DSZ:
  198.  
  199. DSZ supports Xmodem, Xmodem CRC, Xmodem 1k (also called Ymodem),
  200. Ymodem Batch, Ymodem-G and Zmodem.  Versions after 06-07-88 must be
  201. registered (ie: run putsnp) before Ymodem-G will work.  All new
  202. versions also added MobyTurbo Zmodem, which supposedly gives
  203. Ymodem-G transfer times with Zmodem 32 bit error detection (best of
  204. both worlds?).  It requires little setup parameters, as it reads the
  205. com information from the uart and goes from there.  In fact on most
  206. systems you can just type dsz rz and you can recieve a file with zmodem.
  207.  
  208. You can get the latest version of DSZ from the dsz bbs at (503) 621-3746.
  209. Download as DSZ.ZIP.
  210.  
  211. DSZ uses the comport at whatever baud rate it is currently set at.
  212. There is no need to tell it what baud rate to use.
  213.  
  214. The examples in the protocol.bat should work for most systems.  You
  215. may need to turn handshaking on (ha on) for those with locked ports
  216. or with high speed modems.  ex: dsz port %2 ha on sz %4
  217.  
  218. For the Xmodem protocol DSZ will check for checksum or CRC error
  219. detection automatically.  You don't need two selections for xmodem
  220. like most bbs packages do.
  221.  
  222. For the 9600 systems, here is the change you need to make:
  223.  
  224. for 2400: dsz port %2 sz %4
  225. for 9600: dsz port %2 ha on sz %4
  226.  
  227. SUPERK:     (SUPERK44.ZIP)
  228.  
  229. Superk supports Xmodem, Xmodem CRC, Ymodem (Xmodem 1k), WXmodem (windowed
  230. xmodem), Jmodem, K9Xmodem, Super8K and MNP Super8K-G.  These are the
  231. ones supported in Ver 4.4.  Earlier versions like 3.3 do not support
  232. the MNP Super8k or Jmodem.  There are also command line differences
  233. between the versions (I have only seen 3.3 and 4.4).  Version 4.4
  234. will be posted on His Board if you are interested in it, otherwise
  235. the latest version of the program can be obtained at the authors BBS
  236. at (206) 725-9233 12/24/9600.  Its been a long time since I've messed
  237. with superk so your on your own with this protocol package.  If I'm
  238. not passing sufficient information to protocol.bat for superk to
  239. work correctly, let me know.
  240.  
  241. Superk requires that you pass it the port number and baudrate.  These
  242. are passed via %2 and %3 from CdCom.  It may also require the locked
  243. port speed.
  244.  
  245. Examples (for ver 4.4):
  246.  
  247. Px      - Comm Port to use.
  248. Sbaud   - Port Speed.
  249. F name  - Filename to xfer
  250.  
  251. Protocols:
  252. S is for Send.
  253.  
  254. X = Xmodem
  255. C = CRC Xmodem
  256. Y = Ymodem (1k Xmodem)
  257. W = WXmodem
  258. J = Jmodem
  259. K = K9Xmodem
  260. S = Super8K
  261. M = MNP Super8K-G
  262.  
  263. Wxmodem
  264. superk p%2 s%3 sw f %4
  265.  
  266. Super8k
  267. superk p%2 s%3 ss f %4
  268.  
  269. for ver 3.3 an example would be:
  270.  
  271. t=protocol to use (same as above, sans J and M)
  272. d=direction of transfer (s=send)
  273.  
  274. Super8k
  275. superk p%2 s%3 ts ds f%4
  276.  
  277. Wxmodem
  278. superk p%2 s%3 tw ds f%4
  279.  
  280. Other protocols available:
  281.  
  282. PCZ0221.ZIP   - Sealink, Zmodem, Xmodem Chksum/CRC, Xmodem 1k (Ymodem) Ver 2.21
  283. CLINK120.ZIP  - Sealink + C Source   Ver 1.2
  284. MLINK16.ZIP   - Megalink  Ver 1.6
  285.  
  286. No option for Bi-Modem at this time, since it requires special files
  287. to be created.  I have yet to put any serious time into bi-modem so
  288. dunno if it feasible or not to work with the door.
  289.  
  290.